/**
 ******************************************************************************
 * @file    watermark.h
 * @author  Chavis.Chen
 * @version V1.0.0
 * @date    26-Sep-2018
 * @brief   This file contains the common definitions, macros and functions to
 *          be shared throughout the project.
 ******************************************************************************
 *
 *  The MIT License
 *  Copyright (c) 2018 Chavis.Chen.
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is furnished
 *  to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
 *  IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ******************************************************************************
 */


#ifndef _WATERMARK_H
#define _WATERMARK_H


#include "ring_buffer.h"
#include <pthread.h>

typedef enum
{
	WM_EVENT_LOW,
	WM_EVENT_HIGH,
	WM_EVENT_EMPTY
} wm_event_e;

typedef struct
{
	ring_buffer_handle_t 	ringBuffer;
	uint32					lowVal;
	uint32					highVal;
	bool					isReachedLow;
	bool					isReachedHigh;
	void					(* cb)(wm_event_e, void *);
	pthread_mutex_t			mutex;
} wm_t, * wm_handle_t;


extern OSStatus wm_init(wm_handle_t * wm_handle_ptr, uint32 bufSz, uint32 lowVal, uint32 highVal, void (* cb)(wm_event_e, void *));
extern OSStatus wm_deinit(wm_handle_t * wm_handle_ptr);
extern OSStatus wm_read(wm_handle_t * wm_handle_ptr, uint8 * buf, uint32 toReadLen, uint32 * pActualReadLen, void * lowCbArgv, void * emptyCbArgv);
extern OSStatus wm_write(wm_handle_t * wm_handle_ptr, uint8 * buf, uint32 toWriteLen, uint32 * pActualWriteLen, void * highCBArgv);
extern OSStatus wm_cnt(wm_handle_t * wm_handle_ptr, uint32 * pWmCnt);

#endif

